home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / disk / backuputils / barc11b.lha / BackARC / BackARC.DOC < prev    next >
Encoding:
Text File  |  1993-12-22  |  9.4 KB  |  259 lines
  1.  
  2.   *************************************************************************
  3.   * »»»»»»»»»»»»»»»»»»»»»»»»»» BackARC V1.1 ßETA «««««««««««««««««««««««« *
  4.   *************************************************************************
  5.   *                          The Directory Spooler                        *
  6.   *                           by Stephen Bradley                          *
  7.   *                  Docs by Stephen Bradley and Harley McGrew            *
  8.   *************************************************************************
  9.  /                                                                         \
  10. <                                                                           >
  11. /                                                                           \
  12.  
  13. I.  Introduction
  14.  
  15.   a.  What is BackARC?
  16.  
  17.       BackARC is my answer to a lazy man's request.  (So what if that lazy
  18.     man just happened to be me!)  It was created for the same reason printer
  19.     spools were created:  to alleviate some extranious activities for people
  20.     who are extremely impatient.  :-)  BackARC is a program designed to sit
  21.     in the background and unpack files. NOTE: Now it's time to be excited,
  22.     because BackARC is more than a program to unpack files.  More on this
  23.     later.
  24.  
  25.  
  26.  
  27.   b.  Who is BackARC for?
  28.  
  29.       BackARC is designed for the avid Amiga user who wishes to call BBS's
  30.     and download files without having to unpack them later.  This allows
  31.     anxious people (such as myself) to IMMEDIATELY use the programs once
  32.     they are downloaded, or at least a minute or two later. :) BackARC
  33.     is most useful to users who have hard drives, since unpacked information
  34.     usually takes up a great deal more space than packed.
  35.  
  36.   c.  What BackARC is:
  37.  
  38.       A tool designed to unpack files for you while you are online.
  39.  
  40.       A powerful spooler which can use multiple archivers and multiple
  41.    spooling directories.
  42.  
  43.       An easy soloution for any Amiga user who wants a simple function
  44.    done without going through the hassle of writing an AmigaDOS or
  45.    Arexx script to do it.
  46.  
  47.       A Commodity.  BackARC can be toggled via left alt + control b
  48.    (changeable in the tooltype).  Clicking on the close gadget EXITS
  49.    BackARC.
  50.  
  51.   d.  What BackARC isn't:
  52.  
  53.       A system hog.  BackARC tries to use as little resources as possible
  54.    in order to get the job done.
  55.  
  56. II.  Operation
  57.  
  58.   a.  What is a Scanfunction?
  59.  
  60.       A Scanfunction is my term given for a group of items entered together
  61.    to form a part of the internal spool database BackARC keeps up
  62.    with while it is running.  A scanfunction is made up of the
  63.    following elements:
  64.  
  65.      Name - Identifies the specific scanfunction.
  66.  
  67.      Archiver - Program used to unpack the files with. e.g. LhA.
  68.  
  69.      Directory - BackARC scans this directory for files and
  70.          unpacks them to this directory.  YOU *MUST* EITHER HAVE A TRAILING
  71.          / OR : AFTER THE DIRECTORY for BackARC to work properly.  If you
  72.          use the asl requester, this will be automatically added for you.
  73.  
  74.      Options - Identifies the specific options required in order to
  75.             tell the archiver to unpack, as opposed to pack.
  76.  
  77.      Line Format - Identifies which format to build the command
  78.            line with.
  79.  
  80.       A maximum of 255 different scanfunctions can be defined and saved
  81.     at one time within BackARC.
  82.  
  83.   b.  Windows
  84.  
  85.       BackARC has three different windows that it opens:
  86.  
  87.      Main window - shows status of BackARC.
  88.  
  89.        Consists of two gadgets:
  90.  
  91.          Active - If checked, then BackARC is actively scanning
  92.              it's scanfunctions at the interval specified.
  93.  
  94.          Setup  - Opens the configuration window.
  95.  
  96.      Configuration window - allows for the alteration and addition
  97.              of scanfunctions, and the alteration of
  98.              BackARC's other options.
  99.  
  100.        Consists of ten gadgets:
  101.  
  102.          Scanfunctions - A list of current scanfunctions defined.
  103.                This list is used to select which scanfunction
  104.                is to be either edited or erased from the list.
  105.  
  106.          Add       - Brings up the entry window with the intent
  107.                of adding a new scanfunction to the list.
  108.  
  109.          Edit      - Brings up the entry window with the intent
  110.                of altering an existing scanfunction.  The
  111.                scanfunction to be edited should be selected
  112.                from the list.  If a function is NOT selected,
  113.                then the screen will flash.
  114.  
  115.          Erase     - The scanfunction to be erased should be
  116.                selected from the list.  If a function is NOT
  117.                selected, then the screen will flash.  Once
  118.                the scanfunction is erased, the others after
  119.                it will be moved up from the list.
  120.  
  121.          Make
  122.          Directories   - If checked, then BackARC will make a directory
  123.                based upon the name of the archive it is
  124.                unpacking when it finds an archive that meets
  125.                the specifications for a specific scanfunc.
  126.                All files retrieved from the archive will be
  127.                placed into this directory.
  128.  
  129.          Erase|Rename
  130.          Archives     - Tells BackARC whether to erase an archive
  131.                after unpacking it, or rename it to something
  132.                else so that BackARC won't try to unpack it
  133.                again.
  134.  
  135.          Seconds      - Sets the interval which BackARC waits before
  136.                scanning for archives under it's scanfunctions.
  137.                Every scanfunction's directory is scanned
  138.                for a matching archive, if one is found, then
  139.                after unpacking the archive, the remainder
  140.                of archives are skipped until the next scan.
  141.  
  142.          Priority     - Sets BackARC's task priority for operations.
  143.  
  144.          Configuration
  145.          Load|Save     - Saves or loads BackARC's configuration files.
  146.                These files will be loaded at startup and
  147.                active operations will be begun immediately
  148.                upon successful startup.
  149.  
  150.      Entry window - allows for the editing or addition of a
  151.           scanfunction.
  152.  
  153.        Consists of ten gadgets, specifying aspects of a scanfunction
  154.      described above, and an Ok gadget to accept changes/additions, or
  155.      Cancel to discard changes/additions.
  156.  
  157.   c.  ToolTypes
  158.  
  159.       BackARC understands a number of tooltypes.  The tooltypes supported
  160.     are as follows:
  161.  
  162.    XPOS - The X coordinate of the display window on startup.
  163.  
  164.    YPOS - The Y coordinate of the display window on startup.
  165.  
  166.    COPYRIGHT - Displays copyright notice of program on startup if
  167.           specified in the tooltypes.
  168.  
  169.    LOGFILE - Logs any scanfunction activity.  If not specified/commented
  170.         out, then will not log any activity.
  171.  
  172.    CFGFILE - Changes the default configuration filename.  The default
  173.         is S:BackARC.config.
  174.  
  175.    SFFILE - Changes the default scanfunction list filename.  The
  176.        default is S:BackARC.scanfuncs.
  177.  
  178.    SIZE - This is a security mechanism designed to help in the
  179.           detection of link/file viruses. This should be set
  180.           to the size as shown in the tooltypes window.   If
  181.           a requester comes up telling of an alteration in the
  182.           program size, it would be wise to scan the file for
  183.           viruses using a link/file virus scanning program of
  184.           some kind.  This "feature" can be disabled by commenting
  185.           out or deleting the size entry. The program will
  186.           function the same as it would if the size were the
  187.           same.
  188.  
  189.           NOTE:  This can also be specified for the command line.
  190.                  Be sure that you enter the size which matches that
  191.                  of the BackARC executable! e.x.
  192.  
  193.                  BackARC is 29380 bytes in length.  At shell prompt:
  194.  
  195.                  1.SYS> RUN >NIL: BackARC SIZE=29380     [other options]
  196.  
  197.    d. Requirements:
  198.  
  199.        Workbench 2.04 or up.
  200.        mathieeedoubbas.library
  201.        mathieeetrans.library
  202.        asl.library
  203.        commodities.library
  204.  
  205. III.   Alternative uses for BackARC
  206.  
  207.           Currently, BackARC can do many functions besides unarchive.
  208.        With proper manipulation of the OPT field in setup, the possibilities
  209.        are almost endless.  (Very soon, a even MORE versatile interface will
  210.        be used). Here is just a short list of the possibilities:
  211.  
  212.        Picture Conversion
  213.        Picture Displaying
  214.        Virus Scanning
  215.        CR/LF Conversion
  216.        UUEncode/UUDecode -ing
  217.        Logfile appention
  218.        Updating of new program versions
  219.        Execution
  220.        Sound/Music File playing
  221.        Source File linking/compilation
  222.        Print files
  223.        ScriptFile execution
  224.  
  225.  
  226. ***********************************************
  227.              NOTICE TO USERS!!!
  228. ***********************************************
  229.  
  230.    This program is still in ßeta, I can not
  231. assume responsibility for any damage caused by
  232. this program.  If this program causes a problem
  233. please notify me via the addresses below.
  234.  
  235.  
  236.                  -Thanks
  237.                  Stephen
  238.  
  239. ************************************************
  240.  
  241. Questions/Comments/Criticisms:
  242.  
  243.    Stephen Bradley
  244.    1245 Castlegate Court
  245.    Winston-Salem, NC  27103
  246.    USA
  247.  
  248.    Internet/Usenet:
  249.  
  250.    sbradley@wsalem.cerf.fred.org  (This address is inoperative at this
  251.                time!  Will be established by
  252.                1/5/1994)
  253.  
  254.    LhA is Copyright (c) 1991,92 Stefan Boberg
  255.  
  256.    Workbench 2.04, mathieeedoubbas.library, mathieeetrans.library,
  257. asl.library, and commodities.library are Copyright ©1985-1991
  258. Commodore-Amiga Inc.
  259.